<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    package org.apache.commons.math.stat.descriptive;<a name="line.17"></a>
<FONT color="green">018</FONT>    <a name="line.18"></a>
<FONT color="green">019</FONT>    import org.apache.commons.math.MathRuntimeException;<a name="line.19"></a>
<FONT color="green">020</FONT>    import org.apache.commons.math.util.MathUtils;<a name="line.20"></a>
<FONT color="green">021</FONT>    <a name="line.21"></a>
<FONT color="green">022</FONT>    /**<a name="line.22"></a>
<FONT color="green">023</FONT>     *<a name="line.23"></a>
<FONT color="green">024</FONT>     * Abstract implementation of the {@link StorelessUnivariateStatistic} interface.<a name="line.24"></a>
<FONT color="green">025</FONT>     * &lt;p&gt;<a name="line.25"></a>
<FONT color="green">026</FONT>     * Provides default &lt;code&gt;evaluate()&lt;/code&gt; and &lt;code&gt;incrementAll(double[])&lt;code&gt;<a name="line.26"></a>
<FONT color="green">027</FONT>     * implementations.&lt;/p&gt;<a name="line.27"></a>
<FONT color="green">028</FONT>     * &lt;p&gt;<a name="line.28"></a>
<FONT color="green">029</FONT>     * &lt;strong&gt;Note that these implementations are not synchronized.&lt;/strong&gt;&lt;/p&gt;<a name="line.29"></a>
<FONT color="green">030</FONT>     *<a name="line.30"></a>
<FONT color="green">031</FONT>     * @version $Revision: 780637 $ $Date: 2009-06-01 08:48:32 -0400 (Mon, 01 Jun 2009) $<a name="line.31"></a>
<FONT color="green">032</FONT>     */<a name="line.32"></a>
<FONT color="green">033</FONT>    public abstract class AbstractStorelessUnivariateStatistic<a name="line.33"></a>
<FONT color="green">034</FONT>        extends AbstractUnivariateStatistic<a name="line.34"></a>
<FONT color="green">035</FONT>        implements StorelessUnivariateStatistic {<a name="line.35"></a>
<FONT color="green">036</FONT>        <a name="line.36"></a>
<FONT color="green">037</FONT>        /**<a name="line.37"></a>
<FONT color="green">038</FONT>         * This default implementation calls {@link #clear}, then invokes <a name="line.38"></a>
<FONT color="green">039</FONT>         * {@link #increment} in a loop over the the input array, and then uses <a name="line.39"></a>
<FONT color="green">040</FONT>         * {@link #getResult} to compute the return value.  <a name="line.40"></a>
<FONT color="green">041</FONT>         * &lt;p&gt;<a name="line.41"></a>
<FONT color="green">042</FONT>         * Note that this implementation changes the internal state of the<a name="line.42"></a>
<FONT color="green">043</FONT>         * statistic.  Its side effects are the same as invoking {@link #clear} and<a name="line.43"></a>
<FONT color="green">044</FONT>         * then {@link #incrementAll(double[])}.&lt;/p&gt;<a name="line.44"></a>
<FONT color="green">045</FONT>         * &lt;p&gt;<a name="line.45"></a>
<FONT color="green">046</FONT>         * Implementations may override this method with a more efficient and<a name="line.46"></a>
<FONT color="green">047</FONT>         * possibly more accurate implementation that works directly with the<a name="line.47"></a>
<FONT color="green">048</FONT>         * input array.&lt;/p&gt;<a name="line.48"></a>
<FONT color="green">049</FONT>         * &lt;p&gt;<a name="line.49"></a>
<FONT color="green">050</FONT>         * If the array is null, an IllegalArgumentException is thrown.&lt;/p&gt;<a name="line.50"></a>
<FONT color="green">051</FONT>         * @param values input array<a name="line.51"></a>
<FONT color="green">052</FONT>         * @return the value of the statistic applied to the input array<a name="line.52"></a>
<FONT color="green">053</FONT>         * @see org.apache.commons.math.stat.descriptive.UnivariateStatistic#evaluate(double[])<a name="line.53"></a>
<FONT color="green">054</FONT>         */<a name="line.54"></a>
<FONT color="green">055</FONT>        @Override<a name="line.55"></a>
<FONT color="green">056</FONT>        public double evaluate(final double[] values) {<a name="line.56"></a>
<FONT color="green">057</FONT>            if (values == null) {<a name="line.57"></a>
<FONT color="green">058</FONT>                throw MathRuntimeException.createIllegalArgumentException("input values array is null");<a name="line.58"></a>
<FONT color="green">059</FONT>            }<a name="line.59"></a>
<FONT color="green">060</FONT>            return evaluate(values, 0, values.length);<a name="line.60"></a>
<FONT color="green">061</FONT>        }<a name="line.61"></a>
<FONT color="green">062</FONT>        <a name="line.62"></a>
<FONT color="green">063</FONT>        /**<a name="line.63"></a>
<FONT color="green">064</FONT>         * This default implementation calls {@link #clear}, then invokes <a name="line.64"></a>
<FONT color="green">065</FONT>         * {@link #increment} in a loop over the specified portion of the input <a name="line.65"></a>
<FONT color="green">066</FONT>         * array, and then uses {@link #getResult} to compute the return value.  <a name="line.66"></a>
<FONT color="green">067</FONT>         * &lt;p&gt;<a name="line.67"></a>
<FONT color="green">068</FONT>         * Note that this implementation changes the internal state of the<a name="line.68"></a>
<FONT color="green">069</FONT>         * statistic.  Its side effects are the same as invoking {@link #clear} and<a name="line.69"></a>
<FONT color="green">070</FONT>         * then {@link #incrementAll(double[], int, int)}.&lt;/p&gt;<a name="line.70"></a>
<FONT color="green">071</FONT>         * &lt;p&gt;<a name="line.71"></a>
<FONT color="green">072</FONT>         * Implementations may override this method with a more efficient and<a name="line.72"></a>
<FONT color="green">073</FONT>         * possibly more accurate implementation that works directly with the<a name="line.73"></a>
<FONT color="green">074</FONT>         * input array.&lt;/p&gt;<a name="line.74"></a>
<FONT color="green">075</FONT>         * &lt;p&gt;<a name="line.75"></a>
<FONT color="green">076</FONT>         * If the array is null or the index parameters are not valid, an <a name="line.76"></a>
<FONT color="green">077</FONT>         * IllegalArgumentException is thrown.&lt;/p&gt;<a name="line.77"></a>
<FONT color="green">078</FONT>         * @param values the input array<a name="line.78"></a>
<FONT color="green">079</FONT>         * @param begin the index of the first element to include<a name="line.79"></a>
<FONT color="green">080</FONT>         * @param length the number of elements to include<a name="line.80"></a>
<FONT color="green">081</FONT>         * @return the value of the statistic applied to the included array entries<a name="line.81"></a>
<FONT color="green">082</FONT>         * @see org.apache.commons.math.stat.descriptive.UnivariateStatistic#evaluate(double[], int, int)<a name="line.82"></a>
<FONT color="green">083</FONT>         */<a name="line.83"></a>
<FONT color="green">084</FONT>        @Override<a name="line.84"></a>
<FONT color="green">085</FONT>        public double evaluate(final double[] values, final int begin, final int length) {<a name="line.85"></a>
<FONT color="green">086</FONT>            if (test(values, begin, length)) {<a name="line.86"></a>
<FONT color="green">087</FONT>                clear();<a name="line.87"></a>
<FONT color="green">088</FONT>                incrementAll(values, begin, length);<a name="line.88"></a>
<FONT color="green">089</FONT>            }<a name="line.89"></a>
<FONT color="green">090</FONT>            return getResult();<a name="line.90"></a>
<FONT color="green">091</FONT>        }<a name="line.91"></a>
<FONT color="green">092</FONT>    <a name="line.92"></a>
<FONT color="green">093</FONT>        /**<a name="line.93"></a>
<FONT color="green">094</FONT>         * {@inheritDoc}<a name="line.94"></a>
<FONT color="green">095</FONT>         */<a name="line.95"></a>
<FONT color="green">096</FONT>        @Override<a name="line.96"></a>
<FONT color="green">097</FONT>        public abstract StorelessUnivariateStatistic copy();<a name="line.97"></a>
<FONT color="green">098</FONT>    <a name="line.98"></a>
<FONT color="green">099</FONT>        /**<a name="line.99"></a>
<FONT color="green">100</FONT>         * {@inheritDoc}<a name="line.100"></a>
<FONT color="green">101</FONT>         */<a name="line.101"></a>
<FONT color="green">102</FONT>        public abstract void clear();<a name="line.102"></a>
<FONT color="green">103</FONT>    <a name="line.103"></a>
<FONT color="green">104</FONT>        /**<a name="line.104"></a>
<FONT color="green">105</FONT>         * {@inheritDoc}<a name="line.105"></a>
<FONT color="green">106</FONT>         */<a name="line.106"></a>
<FONT color="green">107</FONT>        public abstract double getResult();<a name="line.107"></a>
<FONT color="green">108</FONT>    <a name="line.108"></a>
<FONT color="green">109</FONT>        /**<a name="line.109"></a>
<FONT color="green">110</FONT>         * {@inheritDoc}<a name="line.110"></a>
<FONT color="green">111</FONT>         */<a name="line.111"></a>
<FONT color="green">112</FONT>        public abstract void increment(final double d);<a name="line.112"></a>
<FONT color="green">113</FONT>        <a name="line.113"></a>
<FONT color="green">114</FONT>        /**<a name="line.114"></a>
<FONT color="green">115</FONT>         * This default implementation just calls {@link #increment} in a loop over<a name="line.115"></a>
<FONT color="green">116</FONT>         * the input array.   <a name="line.116"></a>
<FONT color="green">117</FONT>         * &lt;p&gt;<a name="line.117"></a>
<FONT color="green">118</FONT>         * Throws IllegalArgumentException if the input values array is null.&lt;/p&gt;<a name="line.118"></a>
<FONT color="green">119</FONT>         * <a name="line.119"></a>
<FONT color="green">120</FONT>         * @param values values to add<a name="line.120"></a>
<FONT color="green">121</FONT>         * @throws IllegalArgumentException if values is null<a name="line.121"></a>
<FONT color="green">122</FONT>         * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#incrementAll(double[])<a name="line.122"></a>
<FONT color="green">123</FONT>         */<a name="line.123"></a>
<FONT color="green">124</FONT>        public void incrementAll(double[] values) {<a name="line.124"></a>
<FONT color="green">125</FONT>            if (values == null) {<a name="line.125"></a>
<FONT color="green">126</FONT>                throw MathRuntimeException.createIllegalArgumentException("input values array is null");<a name="line.126"></a>
<FONT color="green">127</FONT>            }<a name="line.127"></a>
<FONT color="green">128</FONT>            incrementAll(values, 0, values.length);<a name="line.128"></a>
<FONT color="green">129</FONT>        } <a name="line.129"></a>
<FONT color="green">130</FONT>       <a name="line.130"></a>
<FONT color="green">131</FONT>        /**<a name="line.131"></a>
<FONT color="green">132</FONT>         * This default implementation just calls {@link #increment} in a loop over<a name="line.132"></a>
<FONT color="green">133</FONT>         * the specified portion of the input array.<a name="line.133"></a>
<FONT color="green">134</FONT>         * &lt;p&gt;<a name="line.134"></a>
<FONT color="green">135</FONT>         * Throws IllegalArgumentException if the input values array is null.&lt;/p&gt;<a name="line.135"></a>
<FONT color="green">136</FONT>         * <a name="line.136"></a>
<FONT color="green">137</FONT>         * @param values  array holding values to add<a name="line.137"></a>
<FONT color="green">138</FONT>         * @param begin   index of the first array element to add<a name="line.138"></a>
<FONT color="green">139</FONT>         * @param length  number of array elements to add<a name="line.139"></a>
<FONT color="green">140</FONT>         * @throws IllegalArgumentException if values is null<a name="line.140"></a>
<FONT color="green">141</FONT>         * @see org.apache.commons.math.stat.descriptive.StorelessUnivariateStatistic#incrementAll(double[], int, int)<a name="line.141"></a>
<FONT color="green">142</FONT>         */<a name="line.142"></a>
<FONT color="green">143</FONT>        public void incrementAll(double[] values, int begin, int length) {<a name="line.143"></a>
<FONT color="green">144</FONT>            if (test(values, begin, length)) {<a name="line.144"></a>
<FONT color="green">145</FONT>                int k = begin + length;<a name="line.145"></a>
<FONT color="green">146</FONT>                for (int i = begin; i &lt; k; i++) {<a name="line.146"></a>
<FONT color="green">147</FONT>                    increment(values[i]);<a name="line.147"></a>
<FONT color="green">148</FONT>                }   <a name="line.148"></a>
<FONT color="green">149</FONT>            }<a name="line.149"></a>
<FONT color="green">150</FONT>        }<a name="line.150"></a>
<FONT color="green">151</FONT>        <a name="line.151"></a>
<FONT color="green">152</FONT>        /**<a name="line.152"></a>
<FONT color="green">153</FONT>         * Returns true iff &lt;code&gt;object&lt;/code&gt; is an <a name="line.153"></a>
<FONT color="green">154</FONT>         * &lt;code&gt;AbstractStorelessUnivariateStatistic&lt;/code&gt; returning the same<a name="line.154"></a>
<FONT color="green">155</FONT>         * values as this for &lt;code&gt;getResult()&lt;/code&gt; and &lt;code&gt;getN()&lt;/code&gt;<a name="line.155"></a>
<FONT color="green">156</FONT>         * @param object object to test equality against.<a name="line.156"></a>
<FONT color="green">157</FONT>         * @return true if object returns the same value as this<a name="line.157"></a>
<FONT color="green">158</FONT>         */<a name="line.158"></a>
<FONT color="green">159</FONT>        @Override<a name="line.159"></a>
<FONT color="green">160</FONT>        public boolean equals(Object object) {<a name="line.160"></a>
<FONT color="green">161</FONT>            if (object == this ) {<a name="line.161"></a>
<FONT color="green">162</FONT>                return true;<a name="line.162"></a>
<FONT color="green">163</FONT>            }<a name="line.163"></a>
<FONT color="green">164</FONT>           if (object instanceof AbstractStorelessUnivariateStatistic == false) {<a name="line.164"></a>
<FONT color="green">165</FONT>                return false;<a name="line.165"></a>
<FONT color="green">166</FONT>            }<a name="line.166"></a>
<FONT color="green">167</FONT>            AbstractStorelessUnivariateStatistic stat = (AbstractStorelessUnivariateStatistic) object;<a name="line.167"></a>
<FONT color="green">168</FONT>            return (MathUtils.equals(stat.getResult(), this.getResult()) &amp;&amp; <a name="line.168"></a>
<FONT color="green">169</FONT>                    MathUtils.equals(stat.getN(), this.getN()));<a name="line.169"></a>
<FONT color="green">170</FONT>        }<a name="line.170"></a>
<FONT color="green">171</FONT>        <a name="line.171"></a>
<FONT color="green">172</FONT>        /**<a name="line.172"></a>
<FONT color="green">173</FONT>         * Returns hash code based on getResult() and getN()<a name="line.173"></a>
<FONT color="green">174</FONT>         * <a name="line.174"></a>
<FONT color="green">175</FONT>         * @return hash code<a name="line.175"></a>
<FONT color="green">176</FONT>         */<a name="line.176"></a>
<FONT color="green">177</FONT>        @Override<a name="line.177"></a>
<FONT color="green">178</FONT>        public int hashCode() {<a name="line.178"></a>
<FONT color="green">179</FONT>            return 31* (31 + MathUtils.hash(getResult())) + MathUtils.hash(getN());<a name="line.179"></a>
<FONT color="green">180</FONT>        }<a name="line.180"></a>
<FONT color="green">181</FONT>    <a name="line.181"></a>
<FONT color="green">182</FONT>    }<a name="line.182"></a>




























































</PRE>
</BODY>
</HTML>
